Improve Laravel dd() Output Rendering in Scribe Documentation #893
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Good one, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses an issue where the output of Laravel's dd() function is rendered as plain text in the generated documentation by Scribe. The changes introduce a selective rendering mechanism that safely treats dd() output as HTML while keeping all other API responses as plain text, ensuring proper security.
Laravel dd() detection: The script now checks for the presence of sf-dump in the response to identify dd() output.
Secure rendering: Only the detected dd() output is rendered using innerHTML to display the HTML dump correctly. Other responses continue to use textContent to avoid XSS vulnerabilities.
This update improves the developer experience by ensuring that Laravel debug outputs are correctly formatted in the API documentation, while maintaining security.